Class Objects.Volume
Volumes
Functions
| Volume:Enable() | Enable the volume. |
| Volume:Disable() | Disable the volume. |
| Volume:GetActive() | Determine whether the volume is active or not |
| Volume:GetPosition() | Get the volume's position. |
| Volume:SetPosition(position) | Set the volume's position. |
| Volume:GetRotation() | Get the volume's rotation. |
| Volume:SetRotation(rotation) | Set the volume's rotation. |
| Volume:GetScale() | Get the volume's scale (separately on all 3 axes). |
| Volume:SetScale(scale) | Set the volume's scale (separately on all 3 axes). |
| Volume:GetName() | Get the volume's unique string identifier. |
| Volume:SetName(name) | Set the volume's name (its unique string identifier). |
| Volume:ClearActivators() | Clear activator list for volumes (makes volume trigger everything again) |
| Volume:IsMoveableInside(Moveable) | Check if specified moveable is inside the volume |
Functions
- Volume:Enable()
- Enable the volume.
- Volume:Disable()
- Disable the volume.
- Volume:GetActive()
-
Determine whether the volume is active or not
Returns:
-
bool
true if the volume is active
- Volume:GetPosition()
-
Get the volume's position.
Returns:
-
Vec3
a copy of the volume's position
- Volume:SetPosition(position)
-
Set the volume's position.
Parameters:
- position Vec3 the new position of the volume
- Volume:GetRotation()
-
Get the volume's rotation.
Returns:
-
Rotation
a copy of the volume's rotation
- Volume:SetRotation(rotation)
-
Set the volume's rotation.
Parameters:
- rotation Rotation the volume's new rotation
- Volume:GetScale()
-
Get the volume's scale (separately on all 3 axes).
Returns:
-
Vec3
current volume scale
- Volume:SetScale(scale)
-
Set the volume's scale (separately on all 3 axes).
Parameters:
- scale Vec3 the volume's new scale
- Volume:GetName()
-
Get the volume's unique string identifier.
Returns:
-
string
the volume's name
- Volume:SetName(name)
-
Set the volume's name (its unique string identifier).
Parameters:
- name string The volume's new name
- Volume:ClearActivators()
- Clear activator list for volumes (makes volume trigger everything again)
- Volume:IsMoveableInside(Moveable)
-
Check if specified moveable is inside the volume
Parameters:
- Moveable Moveable which should be checked for containment
Returns:
-
bool
state of the moveable, true if contained, false if not